Skip to content

ci+docs: changelog token to job-level (Scorecard Token-Permissions 0→~10) + OpenSSF Scorecard badge - #55

Merged
Navi Bot (project-navi-bot) merged 1 commit into
mainfrom
fix/changelog-token-permissions
May 25, 2026
Merged

ci+docs: changelog token to job-level (Scorecard Token-Permissions 0→~10) + OpenSSF Scorecard badge#55
Navi Bot (project-navi-bot) merged 1 commit into
mainfrom
fix/changelog-token-permissions

Conversation

@Fieldnote-Echo

Copy link
Copy Markdown
Member

Two OpenSSF Scorecard improvements (current aggregate 7.9/10):

Token-Permissions 0 → ~10 (biggest single lever)

changelog.yml declared a top-level contents: write, and Scorecard zeroes the entire (high-weight) Token-Permissions check on any top-level write. Moved contents: write down to the one release-notes job that needs it (creating the draft Release) and set the workflow top level to contents: read. No behaviour change — the job still has the write scope it requires.

README: OpenSSF Scorecard badge

The OpenSSF API has published this project's results (live score 7.9, from scorecard.yml's post-merge run), so added the official badge to the README badge row (using the current api.scorecard.dev / scorecard.dev domains).

Verified locally

  • zizmor --offline .github/workflows/ → no findings
  • actionlint .github/workflows/changelog.yml → clean
  • structure: top-level contents: read, job-level contents: write

Follow-up (separate, manual): the OpenSSF Best Practices badge will be added once the project is registered + passing at bestpractices.dev.

…adge

- changelog.yml: move contents: write from the workflow top level to the
  release-notes job (the only job that needs it — creating the draft Release);
  top level is now contents: read. Fixes the OpenSSF Scorecard Token-Permissions
  check, which zeroes the whole (high-weight) check on ANY top-level write (0 -> ~10).
- README: add the OpenSSF Scorecard badge (the API has published the project's
  results — live score 7.9 from scorecard.yml's post-merge run).

Verified: zizmor --offline clean, actionlint clean, YAML (top-level contents:
read + job-level contents: write).
@qodo-code-review

Copy link
Copy Markdown

Review Summary by Qodo

Improve Scorecard Token-Permissions and add badge

✨ Enhancement 📝 Documentation

Grey Divider

Walkthroughs

Description
• Move contents: write from workflow top-level to job-level in changelog.yml
  - Fixes OpenSSF Scorecard Token-Permissions check (0 → ~10 points)
  - Only release-notes job needs write permission for creating draft Release
• Add OpenSSF Scorecard badge to README
  - Links to live project score (7.9/10) from scorecard.dev
Diagram
flowchart LR
  A["changelog.yml<br/>top-level: contents: write"] -->|Move to job-level| B["release-notes job<br/>contents: write"]
  B -->|Fixes check| C["OpenSSF Scorecard<br/>Token-Permissions: ~10"]
  D["README.md"] -->|Add badge| E["OpenSSF Scorecard<br/>Badge link"]

Loading

File Changes

1. .github/workflows/changelog.yml Security improvement +3/-1

Move contents write permission to job level

• Changed top-level permissions.contents from write to read
• Added job-level permissions.contents: write to release-notes job
• Updated comment to clarify job-level write permission purpose
• No functional behavior change; same write scope where needed

.github/workflows/changelog.yml


2. README.md 📝 Documentation +1/-0

Add OpenSSF Scorecard badge

• Added OpenSSF Scorecard badge to badge row
• Badge links to live project score (7.9/10) on scorecard.dev
• Uses official api.scorecard.dev badge endpoint

README.md


Grey Divider

Qodo Logo

@qodo-code-review

qodo-code-review Bot commented May 25, 2026

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Qodo Logo

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds an OpenSSF Scorecard badge to the README.md file. There are no review comments, and I have no feedback to provide.

@project-navi-bot
Navi Bot (project-navi-bot) merged commit c366ab1 into main May 25, 2026
18 checks passed
@project-navi-bot
Navi Bot (project-navi-bot) deleted the fix/changelog-token-permissions branch May 25, 2026 18:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants